docs: post-v0.1.0 cleanup — update README, ROADMAP, CURRENT_STATE, web README - #53
Merged
Merged
Conversation
…b README Update all stale documentation to reflect the released v0.1.0 state: - README: remove 'not yet published' caveat, add npm version badges to package table, fix Features list (Scenario Evaluator is v0.2 scope), add CLI usage examples, correct reporter to Markdown-only - ROADMAP: mark M0/M0.5/v0.1.0 as complete with release details, set v0.2.0 as 'Next up', fix docs description (Nextra → Next.js, no API ref) - CURRENT_STATE: fix 'What's Next' (v0.1.0 release is done), update package status table to published/0.1.1/deployed - apps/web/README: replace create-next-app boilerplate with real project description, routes, architecture, dev/test instructions
sepehr-safari
force-pushed
the
docs/post-v0.1.0-cleanup
branch
from
July 8, 2026 09:40
2f18764 to
3dac80a
Compare
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The v0.1.0 release milestone was completed and packages published to npm
(0.1.1), but several documentation files were left in a pre-release state.
This PR brings all docs in sync with the released state.
Changes
README.md
report,scenario list,scenario runis v0.2 scope, added note pointing to roadmap)
v0.2)
ROADMAP.md
(not built in v0.1)
CURRENT_STATE.md
v0.2.0/v0.3.0/v1.0.0 with expanded descriptions
"0.1.1", apps/web "done" → "deployed"
apps/web/README.md
create-next-appboilerplate with real projectdescription, routes table, architecture summary, and dev/test instructions
Docs NOT changed (verified current)
Checklist
pnpm format:check— passpnpm lint— passpnpm typecheck— passpnpm build— passpnpm test— 196 tests pass